org.eclipse.vtp.framework.common
Interface IStringObject

All Superinterfaces:

IDataObject

public interface IStringObject
extends IDataObject

Represents a dynamic sequence of characters.

Author:

Lonnie Pryor

Field Summary

static java.lang.String	FIELD_NAME_LENGTH The name of the length field.
static java.lang.String	TYPE_NAME The name of the string type.

Method Summary

INumberObject	getLength() Returns the length field of this string object.
java.lang.String	getValue() Returns the current value of this data object.
boolean	setValue(java.lang.Object value) Sets the value of this data object to the specified value.

Methods inherited from interface org.eclipse.vtp.framework.common.IDataObject

getField, getType, isEqualTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, isReadOnly, setField, toString

Field Detail

TYPE_NAME

static final java.lang.String TYPE_NAME

The name of the string type.

See Also:

Constant Field Values

FIELD_NAME_LENGTH

static final java.lang.String FIELD_NAME_LENGTH

The name of the length field.

See Also:

Constant Field Values

Method Detail

getLength

INumberObject getLength()

Returns the length field of this string object.

Returns:

The length field of this string object.

getValue

java.lang.String getValue()

Returns the current value of this data object.

Returns:

The current value of this data object.

setValue

boolean setValue(java.lang.Object value)
                 throws java.lang.IllegalStateException

Sets the value of this data object to the specified value.

This method will attempt to coerce the supplied value into a Java String object.

Parameters:

value - The value to assign to this data object.

Returns:

False if the supplied value cannot be coerced into a Java String.

Throws:

java.lang.IllegalStateException - If this object is read-only.